home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / top4026.zip / TOP40.DOC next >
Text File  |  1992-06-20  |  6KB  |  129 lines
  1.  
  2.                 TOP 40 Downloads Bulletin Generator for Spitfire
  3.                                 Version 2.0
  4.                          Release Date: June 20, 1992
  5.  
  6.                             (c) WidowWare, 1992
  7.                          Written By Gary Goldstein
  8.  
  9. Disclaimer: Every effort has been made to debug this utility. However,
  10.             since this is my first utility effort one of those little
  11.             critters may exist. Should one of those little critters be 
  12.             found, please contact this author so that we may exterminate it.
  13.  
  14.             This program is considered Shareware. That is, try it before
  15.             you buy it. If you like it and want to contribute to the
  16.             author's starving family, then please send the $5.00
  17.             registration fee to the address on the registration form.
  18.             More on the registration later.
  19.  
  20. Program Description:
  21. -------------------
  22. This little program will generate a bulletin for you displaying the Top 40
  23. downloads from your BBS. It's easy to set up and use and keep  using as it 
  24. will run perpetually. It reads the CALLERS.LOG file or **ANY** file with a 
  25. similar structure such as backups of previous months' files.
  26.  
  27. I have updated this version from Version 1  to allow  you the  freedom  of
  28. allowing your summary file (TOP40SUM.DAT) to expand with the growth of the
  29. downloaded files list which the program maintains. As you run this program
  30. over a length of time, you will accumulate a long list of files which have
  31. been downloaded from your system.  You may continually  increase  the last 
  32. parameter when you run the program to accomodate  this ever  growing list.
  33. However, you may restart  your program  from scratch  whenever you like by
  34. deleting both  the TOP40DAT.DAT and TOP40SUM.DAT files  which this program
  35. generates and maintains.
  36.  
  37. For example, if you have only had 100  files downloaded  from your system,
  38. set the last parameter to 150. If you've had over 500 downloaded, set this
  39. parameter to 650. And so on. I believe this program will handle over 25,000
  40. different files but I haven't reached that number by a long shot on my own
  41. system (I'm up to around 1750 different and I have my parameter set to 2000
  42. so far). I'd be interested to hear from  anyone who has  run out of  memory
  43. using TOP40 and how many files they had when it happened.
  44.  
  45.  
  46. Set Up:
  47. ------
  48. You can place the program anywhere you like on your hard drive. The 
  49. command line will direct the program to the files it needs. Without 
  50. further adieu let's get on with it.
  51.  
  52. Command Line usage is:
  53. ---------------------
  54.     TOP40 <Callers.log file location> 
  55.           <Name of bulletin to be generated (without extension name)>
  56.           <Maximum number of files to use>
  57.  
  58. Thus, as an example...
  59.  
  60.     TOP40 d:\sf\work\callers.log bullet6 1000
  61.  
  62. will tell the program to use the Callers.log file found in the D:\sf\work
  63. subdirectory and generate the files BULLET6.CLR and BULLET6.BBS  using  a
  64. maximum of 1000 files.  You can then move the bulletin files wherever you 
  65. want or you can even specifywhere to generate the bulletins directly.  Do 
  66. not specify file extensions  for  the bulletin names as this utility will 
  67. generate an ANSI bulletin with the extension of.CLR and an ASCII bulletin 
  68. with an extension of .BBS.  This  will keep in line  with the  extensions 
  69. used by Spitfire for the display of bulletins.
  70.  
  71. So,
  72.  
  73.    TOP40 d:\sf\work\callers.log d:\sf\display\bullet6 1000
  74.  
  75. will also work just fine (notice the bulletin path).
  76.  
  77. You MUST, however, specify the 3 required parameters otherwise the program
  78. will not even ATTEMPT to run.
  79.  
  80. If you want  to build a data file for past months so that the program  can
  81. produce a report based on past months' logs... simple. Specify a file such 
  82. as  JAN92.LOG  as your CALLERS.LOG  file and TOP40 will do the rest. Then,
  83. run it against FEB92.LOG and then MAR92.LOG, etc. You may run the  program 
  84. daily as the  program will keep track of the last date it read and pick up 
  85. only information from subsequent dates.
  86.  
  87. Note: If  your  version is unregistered,  once the month changes, all your 
  88. current month's data will be wiped out and started from scratch.
  89.  
  90. Important Note!!  Once you have run the program, do not attempt to run the 
  91. program using  a  prior  month's backup file as, if you will remember, the 
  92. program keeps track of  the  last  date  it read. If you try to use a file 
  93. containing only records for  dates earlier  than the date it has saved, it 
  94. will return "No records found".
  95. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  96.  
  97. Limitations:
  98. -----------
  99. The only limits here are the lengths of the parameters. As of now, they are
  100. set to a 30 character maximum.  However,  when (and if) you register, I can
  101. modify that to whatever you need.
  102.  
  103. That's all there is to it. If you have any questions about the program,
  104. feel free to leave me a note on my board.
  105.  
  106. Registration:
  107. ------------
  108. Oh, yes. One more thing. The registration. It's only $5 to register and 
  109. this will do 2 things. One, you will get a 'customized' version for use
  110. strictly on your BBS and will eliminate that stuff at the beginning. And
  111. more importantly, it will allow your program to accumulate totals for
  112. succeeding months. For unregistered versions, it will simply erase the 
  113. current month's data and start from scratch when the month changes.  
  114. (Well, I had to do SOMETHING to entice you to part with $5.00 didn't I??).
  115.  
  116. You may send in your reg form to the address on the reg form. If you are
  117. sending a check, please make it out to Gary Goldstein as the bank will
  118. not accept those made out to The Spider's Web.
  119.  
  120. Feel free to contact me with any problems you are having at my BBS.
  121.  
  122. Thanks for trying it.  Gary.
  123.  
  124. If you have any other ideas for Spitfire utilites, let me know. I may even
  125. give you a free registration if I can develop it.
  126.  
  127. The Spider's Web
  128. 702-647-5989
  129. USR HST Dual standard, 24hrs / 7 days